Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdown linting #2284

Merged

Conversation

s-martin
Copy link
Collaborator

@s-martin s-martin commented Mar 2, 2024

  • Fix markdown warnings
  • Add GitHub Action to annotate PRs, if markdown lint warnings exist
  • Add configuration for markdown linting (works for GitHub Action, cmd line/pre commit and VS Code)
  • add runner script
  • add pre-commit hook
  • add some docs

@s-martin s-martin added documentation future3 Relates to future3 development labels Mar 2, 2024
@s-martin s-martin added this to the v3.6 milestone Mar 2, 2024
@s-martin s-martin self-assigned this Mar 2, 2024
documentation/developers/documentation.md Outdated Show resolved Hide resolved
documentation/developers/documentation.md Outdated Show resolved Hide resolved
documentation/developers/documentation.md Outdated Show resolved Hide resolved
run_markdownlint.sh Outdated Show resolved Hide resolved
@s-martin s-martin merged commit c3b622c into MiczFlor:future3/develop Mar 21, 2024
5 checks passed
@s-martin s-martin deleted the future3/fix-docs-and-warnings branch March 21, 2024 09:49
@pabera pabera mentioned this pull request Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation future3 Relates to future3 development
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants